IAxis.Jog method

Commands a never-ending controlled motion at a specified velocity. Unlike IAxis.MoveVelocity, Jog doesn't have BufferMode. It keeps moving until the jog input is reset.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IJogCommand Jog(
       double velocity,
       double acceleration,
       double deceleration,
       double jerk,
       McDirection direction
)

Function Jog(
       velocity As Double,
       acceleration As Double,
       deceleration As Double,
       jerk As Double,
       direction As McDirection
)As IJogCommand

Parameters

velocity

Type: double

The value of the specified velocity. [unit/second]

acceleration

Type: double

The value of the acceleration. The unit is determined by McProfileType. (increasing energy of the motor) [unit/second²] or [second]

deceleration

Type: double

The value of the deceleration. The unit is determined by McProfileType. (decreasing energy of the motor) [unit/second²] or [second]

jerk

Type: double

The value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

direction

Type: McDirection

The direction of a jog move. It can be mcPositiveDirection or mcNegativeDirection.

Return value

Type: IJogCommand

Returns the properties of a jog move.

Remarks

Because Jog keeps controlling the axis, it triggers an error if a limit is reached.